.TH "src/common_util/filepath.h" 3 "common_util" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/common_util/filepath.h \- The class for file path operations\&.  

.SH SYNOPSIS
.br
.PP
\fR#include <string>\fP
.br
\fR#include <iostream>\fP
.br
\fR#include <cstdio>\fP
.br
\fR#include 'filetype\&.h'\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBcutl::filepath\fP"
.br
.RI "The class for file path operations\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "std::ostream & \fBcutl::operator<<\fP (std::ostream &os, const \fBfilepath\fP &fp)"
.br
.RI "Define the output stream operator for filepath object\&. "
.ti -1c
.RI "\fBfilepath\fP \fBcutl::path\fP (const std::string &path)"
.br
.RI "Create a filepath object from a string\&. "
.in -1c
.SH "Detailed Description"
.PP 
The class for file path operations\&. 


.PP
\fBCopyright\fP
.RS 4
Copyright (c) 2024, Spencer\&.Luo\&. All Rights Reserved\&.
.RE
.PP
Licensed under the Apache License, Version 2\&.0 (the 'License'); you may not use this file except in compliance with the License\&. You may obtain a copy of the License at 
.PP
.nf
  http://www\&.apache\&.org/licenses/LICENSE-2\&.0

.fi
.PP
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\&. See the License for the specific language governing permissions and limitations\&.
.PP
\fBAuthor\fP
.RS 4
spencer\&.luo 
.RE
.PP
\fBDate\fP
.RS 4
2024-05-13 
.RE
.PP

.SH "Function Documentation"
.PP 
.SS "std::ostream & cutl::operator<< (std::ostream & os, const \fBfilepath\fP & fp)"

.PP
Define the output stream operator for filepath object\&. 
.PP
\fBParameters\fP
.RS 4
\fIos\fP the std::ostream object 
.br
\fIfp\fP the filepath object to be output 
.RE
.PP
\fBReturns\fP
.RS 4
std::ostream& the reference of the std::ostream object after outputing the filepath object\&. 
.RE
.PP

.SS "filepath cutl::path (const std::string & path)"

.PP
Create a filepath object from a string\&. 
.PP
\fBParameters\fP
.RS 4
\fIpath\fP file path string 
.RE
.PP
\fBReturns\fP
.RS 4
filepath object 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for common_util from the source code\&.
